<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Os1: DBoW2::GeneralScoring Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Os1
   &#160;<span id="projectnumber">1</span>
   </div>
   <div id="projectbrief">OrbSlam2 documentado y modificado</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,'Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_d_bo_w2_1_1_general_scoring.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_d_bo_w2_1_1_general_scoring-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">DBoW2::GeneralScoring Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Base class of scoring functions.  
 <a href="class_d_bo_w2_1_1_general_scoring.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_scoring_object_8h_source.html">ScoringObject.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab0cadafd50b0f2f559f6325a6944f72f"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_bo_w2_1_1_general_scoring.html#ab0cadafd50b0f2f559f6325a6944f72f">mustNormalize</a> (<a class="el" href="namespace_d_bo_w2.html#a53e9e0bcfc25c861815e413a7cf3fa51">LNorm</a> &amp;norm) const =0</td></tr>
<tr class="memdesc:ab0cadafd50b0f2f559f6325a6944f72f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether a vector must be normalized before scoring according to the scoring scheme.  <a href="#ab0cadafd50b0f2f559f6325a6944f72f">More...</a><br /></td></tr>
<tr class="separator:ab0cadafd50b0f2f559f6325a6944f72f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43b3f5fedb19e6a19e17b9813efd17e8"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_bo_w2_1_1_general_scoring.html#a43b3f5fedb19e6a19e17b9813efd17e8">score</a> (const <a class="el" href="class_d_bo_w2_1_1_bow_vector.html">BowVector</a> &amp;v, const <a class="el" href="class_d_bo_w2_1_1_bow_vector.html">BowVector</a> &amp;w) const =0</td></tr>
<tr class="memdesc:a43b3f5fedb19e6a19e17b9813efd17e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes the score between two vectors.  <a href="#a43b3f5fedb19e6a19e17b9813efd17e8">More...</a><br /></td></tr>
<tr class="separator:a43b3f5fedb19e6a19e17b9813efd17e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1796812280a5188e06d8137baa977776"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_bo_w2_1_1_general_scoring.html#a1796812280a5188e06d8137baa977776">~GeneralScoring</a> ()</td></tr>
<tr class="memdesc:a1796812280a5188e06d8137baa977776"><td class="mdescLeft">&#160;</td><td class="mdescRight">Required for virtual base classes.  <a href="#a1796812280a5188e06d8137baa977776">More...</a><br /></td></tr>
<tr class="separator:a1796812280a5188e06d8137baa977776"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af470bccf750689525622f216f07d6f3c"><td class="memItemLeft" align="right" valign="top">static const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_bo_w2_1_1_general_scoring.html#af470bccf750689525622f216f07d6f3c">LOG_EPS</a> = log(DBL_EPSILON)</td></tr>
<tr class="memdesc:af470bccf750689525622f216f07d6f3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log of epsilon.  <a href="#af470bccf750689525622f216f07d6f3c">More...</a><br /></td></tr>
<tr class="separator:af470bccf750689525622f216f07d6f3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class of scoring functions. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1796812280a5188e06d8137baa977776"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual DBoW2::GeneralScoring::~GeneralScoring </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Required for virtual base classes. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab0cadafd50b0f2f559f6325a6944f72f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool DBoW2::GeneralScoring::mustNormalize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespace_d_bo_w2.html#a53e9e0bcfc25c861815e413a7cf3fa51">LNorm</a> &amp;&#160;</td>
          <td class="paramname"><em>norm</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns whether a vector must be normalized before scoring according to the scoring scheme. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">norm</td><td>norm to use </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true iff must normalize </dd></dl>

</div>
</div>
<a id="a43b3f5fedb19e6a19e17b9813efd17e8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual double DBoW2::GeneralScoring::score </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_d_bo_w2_1_1_bow_vector.html">BowVector</a> &amp;&#160;</td>
          <td class="paramname"><em>v</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_d_bo_w2_1_1_bow_vector.html">BowVector</a> &amp;&#160;</td>
          <td class="paramname"><em>w</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Computes the score between two vectors. </p>
<p>Vectors must be sorted and normalized if necessary </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">v</td><td>(in/out) </td></tr>
    <tr><td class="paramname">w</td><td>(in/out) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>score </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af470bccf750689525622f216f07d6f3c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const double GeneralScoring::LOG_EPS = log(DBL_EPSILON)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Log of epsilon. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/alejandro/Desarrollo eclipse/os1/Thirdparty/DBoW2/DBoW2/<a class="el" href="_scoring_object_8h_source.html">ScoringObject.h</a></li>
<li>/home/alejandro/Desarrollo eclipse/os1/Thirdparty/DBoW2/DBoW2/<a class="el" href="_scoring_object_8cpp.html">ScoringObject.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespace_d_bo_w2.html">DBoW2</a></li><li class="navelem"><a class="el" href="class_d_bo_w2_1_1_general_scoring.html">GeneralScoring</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
  </ul>
</div>
</body>
</html>
